/*
 * @(#) $Header$
 *
 * Copyright (C) 2006  Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.baselib.util.iterator;

import java.util.Iterator;

/**
 * Class {@code IterableIterator} makes an iterator usable in the
 * {@code foreach} statement.
 *
 * @param   <E>   the type of the iterator elements.
 *
 * @author   <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.baselib.util.iterator.IterableIterator">Daniel Léonard</a>
 * @version $Revision$
 */
public abstract class IterableIterator<E> implements Iterable<E>, Iterator<E> {

//---------------------------
// Constructor
//---------------------------

   /**
    * Constructor.
    */
   protected IterableIterator() {
   // nothing
      }


//---------------------------
// Implemented methods from java.lang.Iterable
//---------------------------

   /**
    * Makes the iterator usable in the foreach statement.
    * @return   <code>this</code>.
    */
   @Override
   public Iterator<E> iterator() {
      return this;
      }

   }
